DHIS2 Android SDK/org.hisp.dhis.android.core.program

Package-level declarations

Types

data class AnalyticsPeriodBoundary(val programIndicator: String, val boundaryTarget: String, val analyticsPeriodBoundaryType: AnalyticsPeriodBoundaryType, val offsetPeriods: Int?, val offsetPeriodType: PeriodType?) : CoreObject

AnalyticsPeriodBoundaryType

enum AnalyticsPeriodBoundaryType : Enum<AnalyticsPeriodBoundaryType>

BoundaryTargetType

sealed class BoundaryTargetType

CategoryMapping

data class CategoryMapping(val uid: String, val program: String, val categoryId: String, val mappingName: String, val optionMappings: List<CategoryOptionMapping>) : CoreObject

CategoryOptionMapping

data class CategoryOptionMapping(val categoryMapping: String, val optionId: String, val filter: String) : CoreObject

Program

data class Program(val uid: String, val code: String?, val name: String?, val displayName: String?, val created: Date?, val lastUpdated: Date?, val deleted: Boolean?, val shortName: String?, val displayShortName: String?, val description: String?, val displayDescription: String?, val version: Int?, val onlyEnrollOnce: Boolean?, val displayEnrollmentDateLabel: String?, val displayIncidentDate: Boolean?, val displayIncidentDateLabel: String?, val registration: Boolean?, val selectEnrollmentDatesInFuture: Boolean?, val dataEntryMethod: Boolean?, val ignoreOverdueEvents: Boolean?, val selectIncidentDatesInFuture: Boolean?, val useFirstStageDuringRegistration: Boolean?, val displayFrontPageList: Boolean?, val programType: ProgramType?, programTrackedEntityAttributes: List<ProgramTrackedEntityAttribute>?, val relatedProgram: ObjectWithUid?, val trackedEntityType: TrackedEntityType?, val categoryCombo: ObjectWithUid, val access: Access, programRuleVariables: List<ProgramRuleVariable>?, val expiryDays: Int?, val completeEventsExpiryDays: Int?, val expiryPeriodType: PeriodType?, val minAttributesRequiredToSearch: Int?, val maxTeiCountToReturn: Int?, programSections: List<ProgramSection>?, val featureType: FeatureType?, val accessLevel: AccessLevel?, val displayEnrollmentLabel: String?, val displayEnrollmentsLabel: String?, val displayFollowUpLabel: String?, val displayOrgUnitLabel: String?, val displayRelationshipLabel: String?, val displayRelationshipsLabel: String?, val displayNoteLabel: String?, val displayTrackedEntityAttributeLabel: String?, val displayProgramStageLabel: String?, val displayProgramStagesLabel: String?, val displayEventLabel: String?, val displayEventsLabel: String?, val attributeValues: List<AttributeValue>?, val enrollmentCategoryCombo: ObjectWithUid, categoryMappings: List<CategoryMapping>?, val style: ObjectStyle) : BaseNameableObject, CoreObject, ObjectWithStyleKt

ProgramCollectionRepository

class ProgramCollectionRepository : ReadOnlyIdentifiableCollectionRepositoryImpl<Program, ProgramCollectionRepository>

ProgramIndicator

data class ProgramIndicator(val uid: String, val code: String?, val name: String?, val displayName: String?, val created: Date?, val lastUpdated: Date?, val deleted: Boolean?, val shortName: String?, val displayShortName: String?, val description: String?, val displayDescription: String?, val displayInForm: Boolean?, val expression: String?, val dimensionItem: String?, val filter: String?, val decimals: Int?, val aggregationType: AggregationType?, val program: ObjectWithUid?, val analyticsType: AnalyticsType?, val analyticsPeriodBoundaries: List<AnalyticsPeriodBoundary>?, val legendSets: List<ObjectWithUid>?, val categoryCombo: ObjectWithUid, val attributeCombo: ObjectWithUid, val categoryMappingIds: List<String>?) : BaseNameableObject, CoreObject

ProgramIndicatorCollectionRepository

class ProgramIndicatorCollectionRepository : ReadOnlyIdentifiableCollectionRepositoryImpl<ProgramIndicator, ProgramIndicatorCollectionRepository>

ProgramModule

interface ProgramModule

ProgramRule

data class ProgramRule(val uid: String, val code: String?, val name: String?, val displayName: String?, val created: Date?, val lastUpdated: Date?, val deleted: Boolean?, val priority: Int?, val condition: String?, val program: ObjectWithUid?, val programStage: ObjectWithUid?, val programRuleActions: List<ProgramRuleAction>?) : BaseIdentifiableObject, CoreObject

ProgramRuleAction

data class ProgramRuleAction(val uid: String, val code: String?, val name: String?, val displayName: String?, val created: Date?, val lastUpdated: Date?, val deleted: Boolean?, val data: String?, val content: String?, val location: String?, val trackedEntityAttribute: ObjectWithUid?, val programIndicator: ObjectWithUid?, val programStageSection: ObjectWithUid?, val programRuleActionType: ProgramRuleActionType?, val programStage: ObjectWithUid?, val dataElement: ObjectWithUid?, val programRule: ObjectWithUid?, val option: ObjectWithUid?, val optionGroup: ObjectWithUid?, val displayContent: String?, val priority: Int?, val legendSet: ObjectWithUid?) : BaseIdentifiableObject, CoreObject

ProgramRuleActionCollectionRepository

class ProgramRuleActionCollectionRepository : ReadOnlyIdentifiableCollectionRepositoryImpl<ProgramRuleAction, ProgramRuleActionCollectionRepository>

ProgramRuleActionType

enum ProgramRuleActionType : Enum<ProgramRuleActionType>

ProgramRuleCollectionRepository

class ProgramRuleCollectionRepository : ReadOnlyIdentifiableCollectionRepositoryImpl<ProgramRule, ProgramRuleCollectionRepository>

ProgramRuleVariable

data class ProgramRuleVariable(val uid: String, val code: String?, val name: String?, val displayName: String?, val created: Date?, val lastUpdated: Date?, val deleted: Boolean?, val useCodeForOptionSet: Boolean?, val program: ObjectWithUid?, val programStage: ObjectWithUid?, val dataElement: ObjectWithUid?, val trackedEntityAttribute: ObjectWithUid?, val programRuleVariableSourceType: ProgramRuleVariableSourceType?) : BaseIdentifiableObject, CoreObject

ProgramRuleVariableCollectionRepository

class ProgramRuleVariableCollectionRepository : ReadOnlyIdentifiableCollectionRepositoryImpl<ProgramRuleVariable, ProgramRuleVariableCollectionRepository>

ProgramRuleVariableSourceType

enum ProgramRuleVariableSourceType : Enum<ProgramRuleVariableSourceType>

ProgramSection

data class ProgramSection(val uid: String, val code: String?, val name: String?, val displayName: String?, val created: Date?, val lastUpdated: Date?, val deleted: Boolean?, val description: String?, val program: ObjectWithUid?, val attributes: List<TrackedEntityAttribute>?, val sortOrder: Int?, val formName: String?, val renderType: SectionRendering?, val style: ObjectStyle) : BaseIdentifiableObject, CoreObject, ObjectWithStyleKt

ProgramSectionAttributeLink

data class ProgramSectionAttributeLink(val programSection: String, val attribute: String, val sortOrder: Int) : CoreObject

ProgramSectionCollectionRepository

class ProgramSectionCollectionRepository : ReadOnlyIdentifiableCollectionRepositoryImpl<ProgramSection, ProgramSectionCollectionRepository>

ProgramStage

data class ProgramStage(val uid: String, val code: String?, val name: String?, val displayName: String?, val created: Date?, val lastUpdated: Date?, val deleted: Boolean?, val description: String?, val displayDescription: String?, val displayExecutionDateLabel: String?, val displayDueDateLabel: String?, val allowGenerateNextVisit: Boolean?, val validCompleteOnly: Boolean?, val reportDateToUse: String?, val openAfterEnrollment: Boolean?, val repeatable: Boolean?, val featureType: FeatureType?, val formType: FormType?, val displayGenerateEventBox: Boolean?, val generatedByEnrollmentDate: Boolean?, val autoGenerateEvent: Boolean?, val sortOrder: Int?, val hideDueDate: Boolean?, val blockEntryForm: Boolean?, val minDaysFromStart: Int?, val standardInterval: Int?, val enableUserAssignment: Boolean?, programStageSections: List<ProgramStageSection>?, programStageDataElements: List<ProgramStageDataElement>?, val periodType: PeriodType?, val program: ObjectWithUid?, val access: Access, val remindCompleted: Boolean?, val validationStrategy: ValidationStrategy?, val displayProgramStageLabel: String?, val displayEventLabel: String?, val displayEventsLabel: String?, val attributeValues: List<AttributeValue>?, val style: ObjectStyle) : BaseIdentifiableObject, CoreObject, ObjectWithStyleKt

ProgramStageCollectionRepository

class ProgramStageCollectionRepository : ReadOnlyIdentifiableCollectionRepositoryImpl<ProgramStage, ProgramStageCollectionRepository>

ProgramStageDataElement

data class ProgramStageDataElement(val uid: String, val code: String?, val name: String?, val displayName: String?, val created: Date?, val lastUpdated: Date?, val deleted: Boolean?, val displayInReports: Boolean?, val compulsory: Boolean?, val allowProvidedElsewhere: Boolean?, val sortOrder: Int?, val allowFutureDate: Boolean?, fullDataElement: DataElement?, val dataElement: ObjectWithUid?, val programStage: ObjectWithUid?, val renderType: ValueTypeRendering?) : BaseIdentifiableObject, CoreObject

ProgramStageDataElementCollectionRepository

class ProgramStageDataElementCollectionRepository : ReadOnlyIdentifiableCollectionRepositoryImpl<ProgramStageDataElement, ProgramStageDataElementCollectionRepository>

ProgramStageSection

data class ProgramStageSection(val uid: String, val code: String?, val name: String?, val displayName: String?, val created: Date?, val lastUpdated: Date?, val deleted: Boolean?, val sortOrder: Int?, val programIndicators: List<ProgramIndicator>?, val dataElements: List<DataElement>?, val renderType: SectionRendering?, val programStage: ObjectWithUid, val description: String?, val displayDescription: String?) : BaseIdentifiableObject, CoreObject

ProgramStageSectionDataElementLink

data class ProgramStageSectionDataElementLink(val programStageSection: String, val dataElement: String, val sortOrder: Int) : CoreObject

ProgramStageSectionProgramIndicatorLink

data class ProgramStageSectionProgramIndicatorLink(val programStageSection: String, val programIndicator: String) : CoreObject

ProgramStageSectionsCollectionRepository

class ProgramStageSectionsCollectionRepository : ReadOnlyIdentifiableCollectionRepositoryImpl<ProgramStageSection, ProgramStageSectionsCollectionRepository>

ProgramTrackedEntityAttribute

data class ProgramTrackedEntityAttribute(val uid: String, val code: String?, val name: String?, val displayName: String?, val created: Date?, val lastUpdated: Date?, val deleted: Boolean?, val shortName: String?, val displayShortName: String?, val description: String?, val displayDescription: String?, val mandatory: Boolean?, val trackedEntityAttribute: ObjectWithUid?, val allowFutureDate: Boolean?, val displayInList: Boolean?, val program: ObjectWithUid?, val sortOrder: Int?, val searchable: Boolean?, val renderType: ValueTypeRendering?) : BaseNameableObject, CoreObject

ProgramTrackedEntityAttributeCollectionRepository

class ProgramTrackedEntityAttributeCollectionRepository : ReadOnlyNameableCollectionRepositoryImpl<ProgramTrackedEntityAttribute, ProgramTrackedEntityAttributeCollectionRepository>

ProgramType

enum ProgramType : Enum<ProgramType>

SectionDeviceRendering

data class SectionDeviceRendering(val type: SectionRenderingType?)

SectionRendering

data class SectionRendering(val desktop: SectionDeviceRendering?, val mobile: SectionDeviceRendering?)

SectionRenderingType

enum SectionRenderingType : Enum<SectionRenderingType>